Skip to content

[Workers KV] Improving KV getting started guide #22573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 5 commits into from
May 21, 2025
Merged

[Workers KV] Improving KV getting started guide #22573

merged 5 commits into from
May 21, 2025

Conversation

@Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented May 20, 2025

Summary

  1. Adding "Deploy to Cloudflare" button.
  2. Improving the actual code for index.ts so that it's more obvious to see how it gets used in an application.
  3. Improving general structure (e.g. splitting step 6 into two more substeps of the guide to make it clearer.
  4. Adding summary frontmatter to provide context on what we're trying to achieve.
  5. Adding updated frontmatter to start tracking when the tutorial has been last updated.
  6. Using more tangible code examples throughout, rather than keeping it abstract with "VALUE" and "KEY".

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@Oxyjun Oxyjun requested review from a team, elithrar, rts-rob and thomasgauvin as code owners May 20, 2025 12:55
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented May 20, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.

PR Change Summary

Enhanced the Workers KV getting started guide with improved clarity and usability.

  • Added a 'Deploy to Cloudflare' button for quick setup.
  • Improved code examples for better understanding and practical application.
  • Reorganized the guide structure for clarity, including splitting steps into substeps.
  • Introduced frontmatter for tracking updates and providing context.

Modified Files

  • src/content/docs/kv/get-started.mdx
How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions
Copy link
Contributor

github-actions bot commented May 20, 2025

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/kv/ @elithrar, @thomasgauvin, @rts-rob, @oxyjun, @cloudflare/pcx-technical-writing

@github-actions
Copy link
Contributor

github-actions bot commented May 20, 2025 •
edited
Loading

Preview URL: https://0b1361ec.preview.developers.cloudflare.com
Preview Branch URL: https://jun-kv-getting-started-d2c-button.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/kv/get-started/ https://jun-kv-getting-started-d2c-button.preview.developers.cloudflare.com/kv/get-started/

RebeccaTamachiro
RebeccaTamachiro approved these changes May 20, 2025
View reviewed changes
@Oxyjun Oxyjun enabled auto-merge (squash) May 21, 2025 09:47
@Oxyjun Oxyjun merged commit fa80de7 into production May 21, 2025
11 checks passed
@Oxyjun Oxyjun deleted the jun/kv/getting-started-d2c-button branch May 21, 2025 09:55
sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
@Oxyjun @harshil1712
@RebeccaTamachiro @sdnts
[Workers KV] Improving KV getting started guide (cloudflare#22573)
bfcf5fa 
* Improving KV getting started guide

* minor updates

* Adding one sentence.

* Apply suggestions from code review

Co-authored-by: Rebecca Tamachiro <[email protected]>

* Implementing feedback

---------

Co-authored-by: Harshil Agrawal <[email protected]>
Co-authored-by: Rebecca Tamachiro <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@RebeccaTamachiro RebeccaTamachiro RebeccaTamachiro approved these changes

@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner

@thomasgauvin thomasgauvin Awaiting requested review from thomasgauvin thomasgauvin is a code owner

@rts-rob rts-rob Awaiting requested review from rts-rob

Assignees

@elithrar elithrar

@rts-rob rts-rob

@thomasgauvin thomasgauvin

@Oxyjun Oxyjun

Labels

product:kv size/m

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@Oxyjun @RebeccaTamachiro @elithrar @rts-rob @thomasgauvin @harshil1712